CygNet DDS Data Group Copy Utility

Use the CygNet DDS Data Group Copy utility (DdsDataGroupCopy.exe) to copy data groups from one remote device to others within the same Device Definition Service (DDS). You can make several different kinds of changes in a single copy action, including updating one or many data groups within a single remote device, selected remote devices, or all remote devices of a certain type; deleting replaced data groups; and updating UDC mappings on destination data groups.

Best practice recommends that you first perform a copy in Test Mode Only. This produces a report at the bottom of the CygNet DDS Data Group Copy dialog box listing what changes would occur upon execution, and gives you the opportunity to make any necessary adjustments before proceeding.

The CygNet DDS Data Group Copy utility file (DdsDataGroupCopy.exe) is stored in the CygNet\Utilities directory on your host server.

Starting DDS Data Group Copy

Installing and Launching

To install and launch (start) the application or utility using version management:

• Use CygNet Client Installer to install and launch the application. Once installed you can use CygNet Client Installer to start the application.

-OR-

• If previously installed, click Start > All Programs > CygNet > <name of the application or utility> or double-click the desktop shortcut.

Alternatively, browse to the CygNet\Utilities directory using Windows Explorer and double-click the program icon. You can also start an application or utility from a command line. These methods do not provide version management.

The CygNet DDS Data Group Copy dialog box appears.

Sample CygNet DDS Data Group Copy Dialog Box

Aligning Facility Ordinal Values

To successfully copy data groups, the facility "Ordinal" value must be the same for both the source and target devices, before using the utility. To verify a device's facility ordinal value, view the Ordinal column on its Facilities property page. (In CygNet Explorer > Device Definition Service (DDS) > Remote Devices, right-click on a selected device and select Properties to access the Properties dialog box.)

If necessary, edit the target device's facility ordinal value to match that of the source device. Once you have verified that the facility ordinal values are the same, proceed to copying desired data groups using the utility. For more information, see Data Group Ordinals and Facility Ordinals.

Using the CygNet DDS Data Group Copy Utility

Using the CygNet DDS Data Group Copy Utility involves deciding which data groups you want to copy to which remote device(s) and with what effects on the destination remote device(s).

Specifically, use the CygNet DDS Data Group Copy Utility to add, update, replace, and delete data groups. The difference between updating a data group and replacing a data group is that with updating you can specify a subset of items to update within the data group, whereas replacing the data group is identical to deleting the data group and adding it again.

When the Add/Update or Update Only options are selected in the Copy Options area, Update Options become available. You can select to update any or all of these items. If none of these items are selected, no changes are made to the data group in the destination remote device.

To Copy Data Groups

1. Ensure that the facility ordinal values for the intended source and target devices are the same.
2. Open the DDS Data Group Copy utility, to access the CygNet DDS Data Group Copy dialog box.
3. Select the Test Mode Only check box to ensure that you do not mistakenly copy data groups before you have reviewed the changes.
4. Provide information about the source and target devices and data groups to copy.

1. In the Copy From group box, provide information about the source device and data groups.

1. In the DDS Site.Service field, browse for the DDS that contains the data groups you want to modify and select it.
2. In the Device ID to Copy field, browse for the remote device you want to copy data groups from and select it.
3. Click Load Data Group List to load all of the data groups for the selected device ID into the Data Groups to Copy pane.
4. To sort by data group type only, check List Data Group Types. This means that if you select data groups to copy from the list, all data groups of the selected type are copied, not unique instances of the type.
5. Select data groups to copy in the Data Groups to Copy pane. To select multiple data groups at once, press Shift or Ctrl + the desired data group names.

2. In the Copy To group box, provide information about the target device(s) to copy the data groups to.
3. In the Copy Options group box, select the copy options to use.

4. If an "update" copy option is selected (either Add/Update or Update Only), the Update Options group box becomes available. Select the update options to use. See To Select Specific Data Group Elements for Copy for more information about selecting specific data group elements to copy.

5. Test the data group copy action.

1. When you have all information provided, click Copy to test the copy action.
2. A report will be generated in the pane at the bottom of the CygNet DDS Data Group Copy dialog box, listing the changes.
3. Review and verify the changes.
4. If you want to save a file of your changes, click Copy Log to Clipboard and paste the log into a text editor of your choice. The log information can be helpful to troubleshoot errors in a real copy action.
5. If necessary, adjust any settings or properties and repeat steps 4 and 5 until the results are satisfactory.

6. Perform the data group copy action.

   Note: Best practice recommends selecting only one remote device for your first live copy.

1. When you are satisfied with your test copy results, clear the Test Mode Only check box and click Copy to perform a "live" copy.
2. Results from your live copy appear in the pane at the bottom of the CygNet DDS Data Group Copy dialog box.

To Select Specific Data Group Elements for Copy

1. In the Copy Options group box, click a copy option that includes updating (either Add/Update or Update Only). The Update Options group box becomes accessible.
2. In the Update Options group box, select the Udc Data update option and then click Options to access the Advanced Udc Options dialog box and do one of the following.
   • To replace all of the UDCs, click Replace Whole List, and then click OK.
   • To replace only selected UDCs, click Add Selected UDCs, click to select the data group element(s) to update, and then click OK.

     

CygNet DDS Data Group Copy Utility Properties

The following table provides details about the properties of the CygNet DDS Data Group Copy dialog box.

Common Copy Errors and Warnings

The following table provides details about common error and warning messages of the CygNet DDS Data Group Copy dialog box.